コンビニ決済 API一覧

HTTP仕様（.idPass）

HTTP仕様（.json）

Request header		Content-Type: application/x-www-form-urlencoded;charset=windows-31j
Method		POST
Response header		Content-Type: text/plain;charset=windows-31j
Status Code		200：常に200を返却

Request header		Content-Type: application/json;charset=UTF-8
Method		POST
Response header		Content-Type: application/json;charset=UTF-8
Status Code		200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー　　　　　　　 ※以下のエラーコードはhttp200で返却される可能性がございます。　・E90010001 　・E92000001 　・E92000002 　・E91099996 　・E91099997

EntryTranCvs 取引登録

決済取引で必要となる取引IDと取引パスワードの発行を行い、取引を開始します。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
Amount	amount	必須半角数字6桁利用金額利用可能決済金額をご確認ください。
Tax	tax	半角数字6桁税送料利用可能決済金額をご確認ください。

URL

/payment/EntryTranCvs.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "orderID": "ORDER0000001",
  "amount": "1000",
  "tax": "0"
}

URL

/payment/EntryTranCvs.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&Amount=1000&Tax=0

レスポンス

正常

AccessID		accessID		半角英数32桁固定取引ID
AccessPass		accessPass		半角英数32桁固定取引パスワード

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813"
}

レスポンスパラメータ：正常系

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

ExecTranCvs 決済実行

お客様が入力した情報で後続の決済センターと通信を行い決済を実施し、結果を返します。

リクエスト

AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID
Convenience	convenience	必須半角数字5桁固定支払先コンビニコード
CustomerName	customerName	必須全半角40バイト氏名設定可能文字はコンビニの仕様に基づきます。セブンイレブンは半角記号は使用できません。
CustomerKana	customerKana	必須全半角40バイトフリガナ設定可能文字はコンビニの仕様に基づきます。
TelNo	telNo	必須半角数字記号13桁電話番号設定可能な文字は「半角数字と"-"(ハイフン)」です。
PaymentTermDay	paymentTermDay	半角数字2桁支払期限日数省略時は、ショップ情報に設定された支払期限日数で処理されます。支払期限設定可能日数をご確認ください。
PaymentExpiryDateTime	paymentExpiryDateTime	半角数字12桁固定支払期限 yyyyMMddHHmm書式省略時は、支払期限日数で処理されます。支払期限設定可能日数をご確認ください。
MailAddress	mailAddress	半角英数記号256桁結果通知先メールアドレス「コンビニ決済依頼完了のお知らせ」メールを送信する場合は、お客様のメールアドレスを設定してください。
ShopMailAddress	shopMailAddress	半角英数記号256桁加盟店メールアドレスお客様へ「コンビニ決済依頼完了のお知らせ」メールを送信する際に、加盟店様にもBCCにて送信する場合メールアドレスを設定してください。省略時は、ショップ情報に設定されたメールアドレスで処理されます。
ReserveNo	reserveNo	半角英数20桁予約番号
MemberNo	memberNo	半角英数20桁会員番号
RegisterDisp1	registerDisp1	全角32バイト POSレジ表示欄1 表示するショップ名称を設定してください。
RegisterDisp2	registerDisp2	全角32バイト POSレジ表示欄2
RegisterDisp3	registerDisp3	全角32バイト POSレジ表示欄3
RegisterDisp4	registerDisp4	全角32バイト POSレジ表示欄4
RegisterDisp5	registerDisp5	全角32バイト POSレジ表示欄5
RegisterDisp6	registerDisp6	全角32バイト POSレジ表示欄6
RegisterDisp7	registerDisp7	全角32バイト POSレジ表示欄7
RegisterDisp8	registerDisp8	全角32バイト POSレジ表示欄8
ReceiptsDisp1	receiptsDisp1	全角60バイトレシート表示欄1
ReceiptsDisp2	receiptsDisp2	全角60バイトレシート表示欄2
ReceiptsDisp3	receiptsDisp3	全角60バイトレシート表示欄3
ReceiptsDisp4	receiptsDisp4	全角60バイトレシート表示欄4
ReceiptsDisp5	receiptsDisp5	全角60バイトレシート表示欄5
ReceiptsDisp6	receiptsDisp6	全角60バイトレシート表示欄6
ReceiptsDisp7	receiptsDisp7	全角60バイトレシート表示欄7
ReceiptsDisp8	receiptsDisp8	全角60バイトレシート表示欄8
ReceiptsDisp9	receiptsDisp9	全角60バイトレシート表示欄9
ReceiptsDisp10	receiptsDisp10	全角60バイトレシート表示欄10
ReceiptsDisp11	receiptsDisp11	全半角42バイトお問い合わせ先管理画面で未設定の場合は必須です。設定方法は管理画面マニュアルの「バウチャー受領書表示デフォルト値を設定する」をご確認ください。どちらも設定した場合は本パラメーターが優先されます。
ReceiptsDisp12	receiptsDisp12	半角数字記号12桁お問い合わせ先電話番号管理画面で未設定の場合は必須です。設定方法は管理画面マニュアルの「バウチャー受領書表示デフォルト値を設定する」をご確認ください。どちらも設定した場合は本パラメーターが優先されます。
ReceiptsDisp13	receiptsDisp13	半角数字記号11桁固定お問い合わせ先受付時間例) 09:00-18:00 管理画面で未設定の場合は必須です。設定方法は管理画面マニュアルの「バウチャー受領書表示デフォルト値を設定する」をご確認ください。どちらも設定した場合は本パラメーターが優先されます。
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3
ClientFieldFlag	clientFieldFlag	半角数字1桁固定加盟店自由項目返却フラグ

URL

/payment/ExecTranCvs.json

リクエストパラメータ

{
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001",
  "convenience": "00007",
  "customerName": "山田太郎",
  "customerKana": "ヤマダタロウ",
  "telNo": "1234567890",
  "receiptsDisp11": "お問い合わせ先",
  "receiptsDisp12": "1234567890",
  "receiptsDisp13": "09:00-18:00"
}

URL

/payment/ExecTranCvs.idPass

リクエストパラメータ

AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001&Convenience=00007&CustomerName=山田太郎&CustomerKana=ヤマダタロウ&TelNo=1234567890&ReceiptsDisp11=お問い合わせ先&ReceiptsDisp12=1234567890&ReceiptsDisp13=09:00-18:00

レスポンス

正常

OrderID	orderID	半角英数記号27桁オーダーID
Convenience	convenience	半角数字5桁固定支払先コンビニコード
ConfNo	confNo	半角英数20桁確認番号お客様が支払い時に使用する番号です。
ReceiptNo	receiptNo	半角英数32桁受付番号お客様が支払い時に使用する番号です。
PaymentTerm	paymentTerm	半角数字14桁固定支払期限日時 yyyyMMddHHmmss書式
TranDate	tranDate	半角数字14桁固定処理日時 yyyyMMddHHmmss書式
ReceiptUrl	receiptUrl	半角英数記号256桁払込票URL セブンイレブンの場合のみ返却します。
CheckString	checkString	半角英数32桁 MD5ハッシュ OrderID～TranDate＋ショップパスワードのハッシュ値を返却します。
ClientField1	clientField1	全半角100バイト加盟店自由項目1
ClientField2	clientField2	全半角100バイト加盟店自由項目2
ClientField3	clientField3	全半角100バイト加盟店自由項目3

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "convenience": "00007",
  "confNo": "12345",
  "receiptNo": "123456789012",
  "paymentTerm": "20201225091313",
  "tranDate": "20201225091313",
  "receiptUrl": "https://example.com/receive",
  "checkString": "1e8b27418fcdc9c0214a035cd81c1749",
  "clientField1": "加盟店自由項目1",
  "clientField2": "加盟店自由項目2",
  "clientField3": "加盟店自由項目3"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Convenience=00007&ConfNo=12345&ReceiptNo=123456789012&PaymentTerm=20201225091313&TranDate=20201225091313&ReceiptUrl=https://example.com/receive&CheckString=1e8b27418fcdc9c0214a035cd81c1749&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

CvsCancel 支払停止

コンビニ決済センターとの通信を行い取引の支払停止処理を行います。

リクエスト

ShopID	shopID	必須半角英数13桁ショップID
ShopPass	shopPass	必須半角英数64桁ショップパスワード
AccessID	accessID	必須半角英数32桁固定取引ID
AccessPass	accessPass	必須半角英数32桁固定取引パスワード
OrderID	orderID	必須半角英数記号27桁オーダーID

URL

/payment/CvsCancel.json

リクエストパラメータ

{
  "shopID": "tshop11223344",
  "shopPass": "PASSWORD",
  "accessID": "a6a6b0061347e90cdef806b39bd28705",
  "accessPass": "5e0e54b892e14ed03e8cf807a6053813",
  "orderID": "ORDER0000001"
}

URL

/payment/CvsCancel.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&OrderID=ORDER0000001

レスポンス

正常

OrderID		orderID		半角英数記号27桁オーダーID
Status		status		半角英字6桁現状態成功時は以下のステータスが返却されます。 CANCEL

異常

ErrCode		errCode		半角英数3桁固定エラーコード
ErrInfo		errInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

{
  "orderID": "ORDER0000001",
  "status": "CANCEL"
}

レスポンスパラメータ：正常系

OrderID=ORDER0000001&Status=CANCEL

レスポンスパラメータ：異常系

{
    "errCode":"E01",
    "errInfo":"E01040001"
}

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

SearchTradeMulti 取引状態参照

指定したオーダーIDの取引情報を取得します。※idPass版にのみ対応しています。json版には対応しておりません。

リクエスト

ShopID		必須半角英数13桁ショップID
ShopPass		必須半角英数64桁ショップパスワード
OrderID		必須半角英数記号27桁オーダーID
PayType		必須半角数字1桁固定決済方法 3：コンビニ

URL

/payment/SearchTradeMulti.idPass

リクエストパラメータ

ShopID=tshop11223344&ShopPass=PASSWORD&OrderID=ORDER0000001&PayType=3

レスポンス

正常

Status		半角英字11桁現状態 UNPROCESSED：未決済 REQSUCCESS：要求成功 PAYSUCCESS：決済完了 EXPIRED：期限切れ CANCEL：支払停止
ProcessDate		半角数字14桁固定処理日時 yyyyMMddHHmmss書式
AccessID		半角英数32桁固定取引ID
AccessPass		半角英数32桁固定取引パスワード
Amount		半角数字10桁利用金額
Tax		半角数字10桁税送料
SiteID		半角英数13桁サイトID
Currency		半角英数3桁固定通貨コード
ClientField1		全半角100バイト加盟店自由項目1
ClientField2		全半角100バイト加盟店自由項目2
ClientField3		全半角100バイト加盟店自由項目3
PayType		半角数字2桁決済方法 3：コンビニ
CvsCode		半角数字5桁固定支払先コンビニコード
CvsConfNo		半角英数20桁確認番号お客様が支払い時に使用する番号です。
CvsReceiptNo		半角英数32桁受付番号お客様が支払い時に使用する番号です。
PaymentTerm		半角数字14桁固定支払期限日時 yyyyMMddHHmmss書式
FinishDate		半角数字8桁固定入金確定日 yyyyMMdd書式

異常

ErrCode		半角英数3桁固定エラーコード
ErrInfo		半角英数9桁固定エラー詳細コード

レスポンスパラメータ：正常系

Status=PAYSUCCESS&ProcessDate=20201225091313&AccessID=a6a6b0061347e90cdef806b39bd28705&AccessPass=5e0e54b892e14ed03e8cf807a6053813&Amount=100&Tax=8&SiteID=&Currency=JPN&ClientField1=加盟店自由項目1&ClientField2=加盟店自由項目2&ClientField3=加盟店自由項目3&PayType=3&CvsCode=00007&CvsConfNo=12345&CvsReceiptNo=123456789012&PaymentTerm=20201225091313&FinishDate=20201225

レスポンスパラメータ：異常系

ErrCode=E01&ErrInfo=E01040001

コンビニ決済

HTTP仕様（.idPass）

HTTP仕様（.json）

Content-Type: application/x-www-form-urlencoded;charset=windows-31j

POST

Content-Type: text/plain;charset=windows-31j

200：常に200を返却

Content-Type: application/json;charset=UTF-8

POST

Content-Type: application/json;charset=UTF-8

200：正常時 400：入力パラメータエラー、加盟店設定エラー 500：システムエラー 502：決済エラー ※以下のエラーコードはhttp200で返却される可能性がございます。 ・E90010001 ・E92000001 ・E92000002 ・E91099996 ・E91099997

EntryTranCvs 取引登録

リクエスト

レスポンス

正常

異常

ExecTranCvs 決済実行

リクエスト

氏名

フリガナ

電話番号

結果通知先メールアドレス

加盟店メールアドレス

レスポンス

正常

確認番号

受付番号

支払期限日時

処理日時

払込票URL

MD5ハッシュ

異常

CvsCancel 支払停止

リクエスト

レスポンス

正常

異常

SearchTradeMulti 取引状態参照

リクエスト

決済方法

レスポンス

正常

処理日時

通貨コード

決済方法

確認番号

受付番号

支払期限日時

入金確定日

異常